Favicon

You are here: Home > API Reference > Platform > Organization Storageproviders > list storageProviders supported

list storageProviders supported

Required Permission: base.organization.storageProvider.list

list storageProviders supported

GET
https://api.applivery.io/v1/organizations/{organizationId}/storage-providers 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/storage-providers" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/storage-providers", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();
import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/storage-providers",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Responses

200 Response application/json
status boolean optional
data array [object] optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 128 characters
description string optional
≤ 500 characters
organization string optional
Match pattern: ^[a-fA-F0-9]{24}$
provider string optional
s3 gcs
type string optional
default custom
default boolean optional
s3Configuration object optional
security object optional
privateBucket string optional
≤ 128 characters
publicBucket string optional
≤ 128 characters
buildTempFolder string optional
≤ 128 characters
logoFolder string optional
≤ 128 characters
gcsConfiguration object optional
security object optional
bucket string optional
≤ 128 characters
cloudCdn object optional
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
{
    "status": true,
    "data": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "organization": "string",
            "provider": "s3",
            "type": "default",
            "default": true,
            "s3Configuration": {
                "security": {
                    "secretAccessKey": "string",
                    "accessKeyId": "string",
                    "region": "string"
                },
                "privateBucket": "string",
                "publicBucket": "string",
                "buildTempFolder": "string",
                "logoFolder": "string"
            },
            "gcsConfiguration": {
                "security": {
                    "accessKey": "string",
                    "secret": "string",
                    "region": "string"
                },
                "bucket": "string",
                "cloudCdn": {
                    "url": "string",
                    "keyName": "string",
                    "keyValue": "string"
                }
            },
            "updatedAt": "2024-01-01T00: 00:00Z",
            "createdAt": "2024-01-01T00: 00:00Z"
        }
    ]
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5010
message string optional
Billing platform error
{
    "status": false,
    "error": {
        "code": 5010,
        "message": "Billing platform error"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}